Blocks: various optimizations #39734

kraftbj · 2024-10-10T18:50:00Z

Proposed changes:

Adding various small optimizations in an attempt to make load_independent_blocks more performant.
Extension prefix: previously we would search the strings to add/remove jetpack/ from block names continually. Instead of doing those runs, standardize all blocks to only have their unprefixed version e.g. donations so we only need to add it when we need it and we don't need to waste cycles on figuring out if we need to add/remove it. This simplifies the block loading tooling. We still check for the prefix in the userland space.
Manifest is present. Previously, there used to be multiple manifest files possible, but we've stuck with only index.json for awhile. We can simplify the code by not needing the name value to be passed and assume it is already present.
Caching index.json - we can store this in memory after first read to avoid multiple file reads.
Block Discovery - we take the manifest and search in multiple directories for matching blocks. Two of these directories will never contain a block (at least as of now) and so let's not waste the cycles with them.
Minor function moves—with blocks as a module, we can move a couple of calls out of the main Jetpack class to the blocks module file.
Consolidation of function calls. The AI Assistant ran through a number of filter adds all on the same filter. We can simplify by just running one callable attached to the function instead of a dozen.
Hard code directories— there were some instances within each block of determining the block name based on the block folder, which seems like added complexity. If there's nothing dynamic about it, we can simply insert the name directly into the code.

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Verify blocks still load.
You can add do_action( 'qm/start', 'jp_ind_blocks' ); // phpcs:ignore and do_action( 'qm/stop', 'jp_ind_blocks' ); // phpcs:ignore at the start and end of the Jetpack_Gutenberg::load_indepedent_blocks function to measure the difference.

For my testing, there is some difference, but not enough for me to say it is fully optimized. Need to rework a lot of this, I think, to make it more performant.

…jetpack into add/performance-improvements

…ovements

…jetpack into add/performance-improvements

github-actions · 2024-10-10T18:50:49Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/performance-improvements branch.
- For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack add/performance-improvements

bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/performance-improvements

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2024-10-10T18:51:04Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
🔴 Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Choose a review path based on your changes:
- A. Team Review: add the "[Status] Needs Team Review" label
  - For most changes, including minor cross-team impacts.
  - Example: Updating a team-specific component or a small change to a shared library.
- B. Crew Review: add the "[Status] Needs Review" label
  - For significant changes to core functionality.
  - Example: Major updates to a shared library or complex features.
- C. Both: Start with Team, then request Crew
  - For complex changes or when you need extra confidence.
  - Example: Refactor affecting multiple systems.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

…jetpack into add/performance-improvements

…ovements

kraftbj · 2024-10-15T16:55:20Z

The prefix_exists seem to be helpful during unit tests. Will need to work around that.

…ovements

jeherve

This is looking good and tests well. I only have some minor, non-blocking remarks, that could be addressed in a follow-up PR if you prefer.

jeherve · 2024-11-25T13:27:14Z

projects/plugins/jetpack/extensions/blocks/ai-assistant/ai-assistant.php

+			Jetpack_Gutenberg::set_extension_available( 'ai-general-purpose-image-generator' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-site-logo-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-title-optimization-keywords-support' );
+			if ( apply_filters( 'breve_enabled', true ) ) {


Maybe that's a good opportunity to add a docblock for this filter?

jeherve · 2024-11-25T13:28:00Z

projects/plugins/jetpack/extensions/blocks/ai-assistant/ai-assistant.php

+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-form-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-content-lens' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-backend-prompts' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-usage-panel' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-featured-image-generator' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-title-optimization' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-experimental-image-generation-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-general-purpose-image-generator' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-site-logo-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-title-optimization-keywords-support' );


Do you think you could order them alphabetically? It would be easier to quickly parse, I think.

jeherve · 2024-11-25T13:28:38Z

projects/plugins/jetpack/extensions/blocks/ai-assistant/ai-assistant.php

+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-form-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-content-lens' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-backend-prompts' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-usage-panel' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-featured-image-generator' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-title-optimization' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-experimental-image-generation-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-general-purpose-image-generator' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-assistant-site-logo-support' );
+			Jetpack_Gutenberg::set_extension_available( 'ai-title-optimization-keywords-support' );


We now have an extra one, ai-list-to-table-transform, with an extra filter:

jetpack/projects/plugins/jetpack/extensions/blocks/ai-assistant/ai-assistant.php

Lines 82 to 94 in d4e8ec5

/**

* Register the `ai-list-to-table-transform` extension.

*/

add_action(

'jetpack_register_gutenberg_extensions',

function () {

if ( apply_filters( 'jetpack_ai_enabled', true ) &&

apply_filters( 'list_to_table_transform_enabled', false )

) {

\Jetpack_Gutenberg::set_extension_available( 'ai-list-to-table-transform' );

}

}

);

Maybe you can add it to the same function?

I haven't looked, but I wonder if there's any chance of renaming the filter to be prefixed with jetpack_ while we're in there.

jeherve · 2024-11-25T13:34:34Z

projects/plugins/jetpack/modules/blocks.php

+Jetpack_Gutenberg::load_independent_blocks();
+Jetpack_Gutenberg::load_block_editor_extensions();


Those 2 methods were hooked into plugins_loaded in class.jetpack.php. If we can switch them to being loaded in modules/blocks.php (does this mean loading them on after_setup_theme on the frontend), can we do the same with register_block_metadata_collection below?

kraftbj added 7 commits October 9, 2024 14:06

Blocks: various optimizations

5ff452d

Blocks: various optimizations

c07017c

Merge branch 'add/performance-improvements' of github.com:Automattic/…

ed49bfb

…jetpack into add/performance-improvements

Avoid str_starts_with calls when there's a set value already

dd7892a

changelog

d8a851f

Merge remote-tracking branch 'origin/trunk' into add/performance-impr…

8b2ed10

…ovements

Merge branch 'add/performance-improvements' of github.com:Automattic/…

65cb3d6

…jetpack into add/performance-improvements

kraftbj added the [Focus] Performance label Oct 10, 2024

kraftbj self-assigned this Oct 10, 2024

kraftbj added 6 commits October 10, 2024 13:55

Blocks: There are no php files in any of the stores

2c48075

Blocks: There are no php files in any of shared directories

c1bf0ce

Merge branch 'trunk' into add/performance-improvements

bbd97ca

Merge branch 'add/performance-improvements' of github.com:Automattic/…

b92d27d

…jetpack into add/performance-improvements

Merge remote-tracking branch 'origin/trunk' into add/performance-impr…

91a34a0

…ovements

Remove debugging code

b5219ac

kraftbj requested a review from jeherve October 15, 2024 16:32

kraftbj marked this pull request as ready for review October 15, 2024 16:34

kraftbj added [Status] Needs Team Review and removed [Status] In Progress labels Oct 15, 2024

github-actions bot added the [Status] In Progress label Oct 15, 2024

kraftbj removed the [Status] Needs Team Review label Oct 15, 2024

kraftbj added 6 commits October 15, 2024 11:57

Dirty hack for tests

3c41cdd

Merge remote-tracking branch 'origin/trunk' into add/performance-impr…

4ff7eab

…ovements

Merge remote-tracking branch 'origin/trunk' into add/performance-impr…

b7470d6

…ovements

Merge branch 'trunk' into add/performance-improvements

7d88eb8

Merge remote-tracking branch 'origin/trunk' into add/performance-impr…

acd640d

…ovements

Ensure older prefixed form is still accepted

e721e80

kraftbj added [Status] Needs Team Review and removed [Status] In Progress labels Nov 18, 2024

kraftbj added 2 commits November 20, 2024 09:05

Merge branch 'trunk' into add/performance-improvements

fb7ef6b

Merge remote-tracking branch 'origin/trunk' into add/performance-impr…

d4e8ec5

…ovements

jeherve approved these changes Nov 25, 2024

View reviewed changes

jeherve added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Team Review labels Nov 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Blocks: various optimizations #39734

Blocks: various optimizations #39734

kraftbj commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading

kraftbj commented Oct 15, 2024

jeherve left a comment

jeherve Nov 25, 2024

jeherve Nov 25, 2024

jeherve Nov 25, 2024

kraftbj Nov 26, 2024

jeherve Nov 25, 2024

	/**
	* Register the `ai-list-to-table-transform` extension.
	*/
	add_action(
	'jetpack_register_gutenberg_extensions',
	function () {
	if ( apply_filters( 'jetpack_ai_enabled', true ) &&
	apply_filters( 'list_to_table_transform_enabled', false )
	) {
	\Jetpack_Gutenberg::set_extension_available( 'ai-list-to-table-transform' );
	}
	}
	);

		Jetpack_Gutenberg::load_independent_blocks();
		Jetpack_Gutenberg::load_block_editor_extensions();

Blocks: various optimizations #39734

Are you sure you want to change the base?

Blocks: various optimizations #39734

Conversation

kraftbj commented Oct 10, 2024 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Oct 10, 2024 • edited Loading

github-actions bot commented Oct 10, 2024 • edited Loading

kraftbj commented Oct 15, 2024

jeherve left a comment

Choose a reason for hiding this comment

jeherve Nov 25, 2024

Choose a reason for hiding this comment

jeherve Nov 25, 2024

Choose a reason for hiding this comment

jeherve Nov 25, 2024

Choose a reason for hiding this comment

kraftbj Nov 26, 2024

Choose a reason for hiding this comment

jeherve Nov 25, 2024

Choose a reason for hiding this comment

kraftbj commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading